home *** CD-ROM | disk | FTP | other *** search
/ Network Support Library / RoseWare - Network Support Library.iso / apidev / tpapi.exe / DOCS / OLDDOCS.LZH / NWQUEUE.DOC < prev    next >
Text File  |  1992-10-26  |  12KB  |  304 lines
  1.                                 QUEUE SERVICES
  2.                                 ==============
  3.  
  4. -------------------------------------------------------------------------------
  5.  
  6.   AboutServicingQueueJobAndFile (QueueID : OT_BinderyID; JobNumber : WORD;
  7.                                  VAR FileName : FileOfByte) : WORD;
  8.  
  9.     Used to abort the servicing of a job, closes the asscoiated file, and
  10.     removes the job entry from the queue.
  11.  
  12.     QueueID (Input)                   : object ID of the queue
  13.  
  14.     JobNumber (Input)                 : number of the job to abort
  15.  
  16.     FileName (Input/Output)           : the handle of the queue file to be
  17.                                         aborted. Returned from
  18.                                         CreateQueueJobAndFile
  19.  
  20. -------------------------------------------------------------------------------
  21.  
  22.   AttachQueueServerToQueue (QueueID : OT_BinderyID) : WORD;
  23.  
  24.     Attaches a station to a queue as a queue (job) server.
  25.  
  26.     QueueID (Input)                   : object ID of the queue
  27.  
  28. -------------------------------------------------------------------------------
  29.  
  30.   ChangeQueueJobEntry (QueueID : OT_BinderyID; Job : JobStruct) : WORD;
  31.  
  32.     Changes information in a job's entry.
  33.  
  34.     QueueID (Input)                   : object ID of the queue
  35.  
  36.     Job (Input)                       : new details of the job to be changed
  37.  
  38. -------------------------------------------------------------------------------
  39.  
  40.   ChangeQueueJobPosition (QueueID : OT_BinderyID; JobNumber : WORD;
  41.                           NewPosition : BYTE) : WORD;
  42.  
  43.     Changes a job's position in a queue.
  44.  
  45.     QueueID (Input)                   : object ID of the queue
  46.  
  47.     JobNumber (Input)                 : number of the job to move
  48.  
  49.     NewPosition (Input)               : the new position of the job
  50.  
  51. -------------------------------------------------------------------------------
  52.  
  53.   ChangeToClientRights (QueueID : OT_BinderyID; JobNumber : WORD) : WORD;
  54.  
  55.     Allows a queue (job) server to assume the login identity of the client that
  56.     placed the job in the queue.
  57.  
  58.     QueueID (Input)                   : object ID of the queue
  59.  
  60.     JobNumber (Input)                 : number of the job
  61.  
  62. -------------------------------------------------------------------------------
  63.  
  64.   CloseFileAndAbortQueueJob (QueueID : OT_BinderyID; JobNumber : WORD;
  65.                              VAR FileName : FileOfByte) : WORD;
  66.  
  67.     Removes a job from a queue and closes the associated file.
  68.  
  69.     QueueID (Input)                   : object ID of the queue
  70.  
  71.     JobNumber (Input)                 : number of the job to close
  72.  
  73.     FileName (Input/Output)           : the handle of the queue file to abort.
  74.                                         Returned from CreateQueueJobAndFile
  75.  
  76. -------------------------------------------------------------------------------
  77.  
  78.   CloseFileAndStartQueueJob (QueueID : OT_BinderyID; JobNumber : WORD;
  79.                              VAR FileName : FileOfByte) : WORD;
  80.  
  81.     Closes an associated file and releases the job for servicing.
  82.  
  83.     QueueID (Input)                   : object ID of the queue
  84.  
  85.     JobNumber (Input)                 : number of the job to close
  86.  
  87.     FileName (Input/Output)           : the handle of the queue file to close.
  88.                                         Returned from CreateQueueJobAndFile
  89.  
  90. -------------------------------------------------------------------------------
  91.  
  92.   CreateQueue (QueueName : ObjectNameType; QueueType : OT_BinderyType;
  93.                DirectoryHandle : BYTE; PathName : QueuePathNameType;
  94.                VAR QueueID : OT_BinderyID) : WORD;
  95.  
  96.     Creates a new queue on a file server.
  97.  
  98.     QueueName (Input)                 : name of the new queue
  99.  
  100.     QueueType (Input)                 : type of the new queue
  101.  
  102.     DirectoryHandle (Input)           : directory handle pointing to the
  103.                                         location of the new queue
  104.  
  105.     PathName (Input)                  : path pointing to the location of the
  106.                                         new queue
  107.  
  108.     QueueID (Output)                  : the object ID of the new queue
  109.  
  110. -------------------------------------------------------------------------------
  111.  
  112.   CreateQueueJobAndFile (QueueID : OT_BinderyID; VAR Job : JobStruct;
  113.                          VAR FileName : FileOfByte) : WORD;
  114.  
  115.     Places a new job in a queue.
  116.  
  117.     QueueID (Input)                   : object ID of the queue
  118.  
  119.     Job (Input/Ouput)                 : job details of the new job
  120.  
  121.     FileName (Output)                 : the handle of the queue file created
  122.  
  123. -------------------------------------------------------------------------------
  124.  
  125.   DestroyQueue (QueueID : OT_BinderyID) : WORD;
  126.  
  127.     Removes a queue from the bindery and file system of a file server.
  128.  
  129.     QueueID (Input)                   : object ID of the queue to destroy
  130.  
  131. -------------------------------------------------------------------------------
  132.  
  133.   DetachQueueServerFromQueue (QueueID : OT_BinderyID) : WORD;
  134.  
  135.     Removes the requesting station from the queue's list of active queue (job)
  136.     servers.
  137.  
  138.     QueueID (Input)                   : object ID of the queue from which to
  139.                                         detach
  140.  
  141. -------------------------------------------------------------------------------
  142.  
  143.   FinishServicingQueueJobAndFile (QueueID : OT_BinderyID; JobNumber : WORD;
  144.                                   Charge : LONGINT;
  145.                                   VAR FileName : FileOfByte) : WORD;
  146.  
  147.     Allows a queue (job) server to signal QMS when it has completed a job.
  148.  
  149.     QueueID (Input)                   : object ID of the queue
  150.  
  151.     JobNumber (Input)                 : number of the job just completed
  152.  
  153.     Charge (Input)                    : amount to be charged for servicing the
  154.                                         queue job
  155.  
  156.     FileName (Input/Output)           : file handle of the queue file. Returned
  157.                                         from CreateQueueJobAndFile
  158.  
  159. -------------------------------------------------------------------------------
  160.  
  161.   GetQueueJobList (QueueID : OT_BinderyID; VAR JobCount : WORD;
  162.                    VAR JobNumberList : Word250ArrayType;
  163.                    MaxJobNumbers : WORD) : WORD;
  164.  
  165.     Provides a list of all jobs contained in a queue.
  166.  
  167.     QueueID (Input)                   : object ID of the queue
  168.  
  169.     JobCount (Output)                 : number of jobs in the queue
  170.  
  171.     JobNumberList (Output)            : contains the job numbers of all jobs
  172.  
  173.     MaxJobNumbers (Input)             : the maximum number of job details to
  174.                                         return
  175.  
  176. -------------------------------------------------------------------------------
  177.  
  178.   GetQueueJobFileSize (QueueID : OT_BinderyID; JobNumber : WORD;
  179.                        VAR SizeOfFile : LONGINT) : WORD;
  180.  
  181.     Finds the size of the associated file for a job queue.
  182.  
  183.     QueueID (Input)                   : object ID of the queue
  184.  
  185.     SizeOfFile (Output)               : the job's file size
  186.  
  187. -------------------------------------------------------------------------------
  188.  
  189.   ReadQueueCurrentStatus (QueueID : OT_BinderyID; VAR QueueStatus : WORD;
  190.                           VAR NumberOfJobs, NumberOfServers : WORD;
  191.                           VAR ServerIDList : Longint25ArrayType;
  192.                           VAR ServerStationList : Word25ArrayType;
  193.                           MaxNumberOfServers : WORD) : WORD;
  194.  
  195.     Reads the current status of a queue.
  196.  
  197.     QueueID (Input)                   : object ID of the queue
  198.  
  199.     QueueStatus (Output               : the status of the queue
  200.  
  201.     NumberOfJobs (Output)             : number of jobs in the queue
  202.  
  203.     NumberOfServers (Output)          : number of servers attached to queue
  204.  
  205.     ServerIDList (Output)             : list of object ID's of servers that are
  206.                                         attached to the queue
  207.  
  208.     ServerStationList (Output)        : list of connection numbers of the
  209.                                         servers that are attached to the queue
  210.  
  211.     MaxNumberOfServers (Input)        : maximum number of servers to return
  212.                                         information about
  213.  
  214. -------------------------------------------------------------------------------
  215.  
  216.   ReadQueueJobEntry (QueueID : OT_BinderyID; JobNumber : WORD;
  217.                      VAR Job : JobStruct) : WORD;
  218.  
  219.     Retrieves information about a job in a queue.
  220.  
  221.     QueueID (Input)                   : object ID of the queue
  222.  
  223.     JobNumber (Input)                 : job entry number of the job to return
  224.                                         information about
  225.  
  226.     Job (Output)                      : job information of the requested job
  227.  
  228. -------------------------------------------------------------------------------
  229.  
  230.   ReadQueueServerCurrentStatus (QueueID : OT_BinderyID;
  231.                               ServerID : OT_BinderyID;
  232.                               ServerStation : WORD;
  233.                               VAR ServerStatusRecord : Byte64ArrayType) : WORD;
  234.  
  235.     Reads the current status record of an attached queue (job) server.
  236.  
  237.     QueueID (Input)                   : object ID of the queue
  238.  
  239.     ServerID (Input)                  : object ID of the queue server
  240.  
  241.     ServerStation (Input)             : connection number of the queue server
  242.  
  243.     ServerStatusRecord (Output)       : status information of the queue server
  244.  
  245. -------------------------------------------------------------------------------
  246.  
  247.   RemoveJobFromQueue (QueueID : OT_BinderyID; JobNumber : WORD) : WORD;
  248.  
  249.     Removes a job from a queue.
  250.  
  251.     QueueID (Input)                   : object ID of the queue
  252.  
  253.     JobNumber (Input)                 : number of the job to delete
  254.  
  255. -------------------------------------------------------------------------------
  256.  
  257.   RestoreQueueServerRights : WORD;
  258.  
  259.     Restores a server's own login identity after it has assumed the client's
  260.     rights.
  261.  
  262. -------------------------------------------------------------------------------
  263.  
  264.   ServiceQueueJobAndOpenFile (QueueID : OT_BinderyID; TargetJobType : WORD;
  265.                               VAR Job : JobStruct;
  266.                               VAR FileName : FileOfByte) : WORD;
  267.  
  268.     Allows a queue server to request a new job for servicing.
  269.  
  270.     QueueID (Input)                   : object ID of the queue
  271.  
  272.     TargetJobType (Input)             : type of job that the server will
  273.                                         service
  274.  
  275.     Job (Output)                      : information about the job to be
  276.                                         serviced
  277.  
  278.     FileName (Output)                 : returns the handle of the queue file
  279.  
  280. -------------------------------------------------------------------------------
  281.  
  282.   SetQueueCurrentStatus (QueueID : OT_BinderyID; QueueStatus : WORD) : WORD;
  283.  
  284.     Controls the addition of jobs and job servers to a queue by setting or
  285.     clearing bits in the queueStatus byte.
  286.  
  287.     QueueID (Input)                   : object ID of the queue
  288.  
  289.     QueueStatus (Input)               : control byte that determines the status
  290.                                         of the queue
  291.  
  292. -------------------------------------------------------------------------------
  293.  
  294.   SetQueueServerCurrentStatus (QueueID : OT_BinderyID;
  295.                                ServerStatusRecord : Byte64ArrayType) : WORD;
  296.  
  297.     Updates QMS's copy of a queue (job) server's status record.
  298.  
  299.     QueueID (Input)                   : object ID of the queue
  300.  
  301.     ServerStatusRecord (Input)        : contains the new status record of the
  302.                                         server
  303. ------------------------------------------------------------------------------
  304.